DescribeRiskWhiteList
Description
Obtain the whitelist of baseline check risk items.
Request Method
POST
Request Path
/apsara/route/aegis/DescribeRiskWhiteList
Request Parameters Common Parameters
Name | Location | Type | Required | Sample value | Description |
---|---|---|---|---|---|
PageSize | BODY | integer | No | No sample value for this parameter. | specifies the maximum number of records per page in the returned result. default value: 20 |
CurrentPage | BODY | integer | No | No sample value for this parameter. | specifies the number of pages currently returned. default value: 1 |
regionId | BODY | string | Yes | No sample value for this parameter. | region id |
version | BODY | string | No | 2016-01-01 | version of api |
RiskName | BODY | string | No | No sample value for this parameter. | risk item name, supports fuzzy matching. |
Return data
Name | Type | Sample value | Description |
---|---|---|---|
RiskId | long | no demo value | risk item ID. |
TotalCount | integer | no demo value | total number of records returned. |
RequestId | string | no demo value | request ID. |
PageSize | integer | no demo value | page displays the maximum number of records. |
CurrentPage | integer | no demo value | currently returns page number. |
WhiteLists | array | no demo value | whitelist of risk items, see the following parameter description for specific sub-items. |
Count | integer | no demo value | number of current page records. |
Reason | string | no demo value | the reason for adding to the whitelist. |
RiskName | string | no demo value | risk item name. |
Example
Successful Response example
{
"RiskId":"no demo value",
"TotalCount":"no demo value",
"RequestId":"no demo value",
"PageSize":"no demo value",
"CurrentPage":"no demo value",
"WhiteLists":"no demo value",
"Count":"no demo value",
"Reason":"no demo value",
"RiskName":"no demo value"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}